home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / bootup / boot_a2m / msbt35e / batch.doc < prev    next >
Text File  |  1995-05-02  |  9KB  |  297 lines

  1.                     Mouse Boot Batch file processor
  2.                             (C)1992 - SRL
  3.                       Written By Scott R. Lemmon
  4.  
  5. NOTE: this program is not included with the shareware release of Mouse 
  6. Boot but will be sent along with the registered owner disk to anyone who 
  7. sends the $15.00 Shareware fee for Mouse Boot (I figure only a few people 
  8. will need this kind of stuff anyway).  The documentation is provided here 
  9. so you know what you'll be getting.
  10.  
  11.     In order to give Mouse Boot maximum flexibility for advanced users and 
  12. yet retain its small size and simple operation, Mouse Boot 3d.4 now has 
  13. the ability to invoke a batch file processor.  files with the extender 
  14. .BAT can be placed in the MOUSEBT directory and then chosen via Mouse 
  15. Boot in the same way as desktops and assign.sys files.
  16.  
  17.     After Mouse Boot has finished its normal job of renaming files, it 
  18. will run the batch processor program; this, in turn, will search for and 
  19. run a file with the extension .BAT in the MOUSEBT folder.
  20.  
  21.     As with all things mouse boot - you only need worry about this feature 
  22. if you want to use it, otherwise, with no batch files or BATCH.PRG in the 
  23. MOUSEBT folder, Mouse Boot will operate exactly as before.
  24.  
  25.     An alternate way to use BATCH.PRG is by using Install Application, or 
  26. with the newdesk TOS or NeoDesk by draging a batch file to BATCH.PRG.
  27.  
  28.     To create a batch file use any text editor (or a word processor, but 
  29. save the file in ASCII format). 
  30.  
  31.     A Mouse Boot batch file has the following format-
  32.  
  33. This is a Fake
  34. batch file
  35.  
  36. #command
  37. pathname
  38. pathname
  39.  
  40. #command
  41. pathname
  42.  
  43. #end
  44.  
  45.  
  46. All commands, which may be typed in upper or lower case, are preceded 
  47. with an '#' and are followed on each line by whatever inputs they require. 
  48. Any other text will be ignored and can be used for comments - "#end" marks 
  49. the end of the file (what a surprise, huh?).
  50.  
  51.  
  52. >> BATCH FILE COMMANDS <<
  53.  
  54. #COPY
  55. <source pathname (including wildcards)>
  56. <destination path (minus a filename)>
  57.  
  58.  
  59.     This is the wild card copy command, all the files matching path1 will 
  60. be copied to path2.  It can be used to load Ramdisks or copy any file (or 
  61. group of files anywhere)
  62.  
  63. Example: (copies Acc's from root dir to a folder)
  64.  
  65. #copy
  66. c:\*.AC?
  67. c:\accfolder\
  68.  
  69.  
  70. #DELETE
  71. <pathname to delete (including wildcards)>
  72.  
  73.     This will delete selected files from a directory - you can use 
  74. wildcards to specify which files are to be deleted.  This command, 
  75. however, will not delete files in any other directory than the one 
  76. specified - so C:\*.*, for example, would not erase the entire partition 
  77. (unless you kept everything in the root directory).
  78.  
  79. Example: (delete all files with the extension .BAK)
  80.  
  81. #delete
  82. f:\wordproc\*.bak
  83.  
  84. #ECOPY  (copy and modify extension)
  85. <source pathname (including wildcards)>
  86. <destination path (minus filename)>
  87. <extension to give destination>
  88.  
  89.     This command works like COPY except that all files copied will be 
  90. renamed with the extension specified. - this (along with ERENAME) can be 
  91. used to turn files on or off.
  92.  
  93. Example: (copy all ACC or ACX files to a directory naming them all ACC)
  94.  
  95. #ecopy
  96. c:\*.ac?
  97. e:\accstuff\
  98. acc
  99.  
  100.  
  101. #ERENAME (Extension rename)
  102. <pathname (including wildcards)>
  103. <new extension>
  104.  
  105.     This command will rename all matching files with the specified 
  106. extension - useful for switching files on or off
  107.  
  108. Example: (shut off all auto folder programs named "Phil")
  109.  
  110. #erename
  111. c:\auto\*phil*.pr?
  112. prx
  113.  
  114.  
  115. #RENAME
  116. <old pathname (including wildcards)>
  117. <new pathname>
  118.  
  119.     Just your basic rename command - nothing too special, but the "new" 
  120. pathname may use a different path from the "old" effectively moving a file 
  121. by only moving its name (and not its data), but the drive should be the 
  122. same. Though this only renames a single file, the source path may use 
  123. wildcards - the first file matched will be used.
  124.  
  125. Example:
  126.  
  127. #rename
  128. c:\phildog.erk
  129. c:\wafer\philcat.erk
  130.  
  131.  
  132. #RCOPY (copy and rename)
  133. <source pathname (including wildcards)>
  134. <destination pathname>
  135.  
  136.     Copies a file giving it a new name in the process, like rename this is 
  137. a single file command but the source can use wildcards - this feature 
  138. could be used, for example, to copy the active desktop in the MOUSEBT 
  139. folder (since there will only be one) to some destination giving it the 
  140. name DESKTOP.INF.
  141.  
  142. Example:(and even sillier than the last one)
  143.  
  144. #rcopy
  145. c:\philber?.knz
  146. F:\moose\lamma\yak\wafting\deeppile.rug
  147.  
  148.  
  149. #DCREATE
  150. <pathname>
  151.  
  152.     Create a directory (folder) in the specified path - really only useful 
  153. during bootup to make directories on a ramdisk.
  154.  
  155. Example: (make a folder "maudlin" inside "echidna")
  156.  
  157. #dcreate
  158. d:\echidna\maudlin
  159.  
  160.  
  161. Conditional Commands:
  162.  
  163.     Version 1.1 of the batch file processor will let you perform 
  164. certain actions only if the screen resolution is correct.  This can 
  165. allow you to have a specific set of commands to be run for each 
  166. screen rez.
  167.  
  168. #IF REZ
  169. <screen resolution name>
  170. #endif
  171.  
  172.     This command will only perform the commands between #IF REZ and 
  173. #ENDIF if the current screen resolution matches the name under #IF REZ. 
  174. Please take note that #IF REZ commands should not be nested.
  175.  
  176.     The resolution names the command knows are:
  177.  
  178.     st low          - standard ST "LOW" 
  179.     st medium       - standard ST "MEDIUM"
  180.     st high         - standard ST "HIGH"
  181.     tt medium       - TT MEDIUM resolution
  182.     tt high         - TT LOW    resolution
  183.     ultra high      - anything higher (like Moniterms)
  184.  
  185.     TT LOW is not supported as it is not really useful as a boot 
  186. resolution and ST LOW is only supported for the hell of it.  If 
  187. anyone wants TT LOW and is a registered owner of Mouse Boot ask me and
  188. I'll add it.
  189.  
  190.     Also note that BATCH.PRG has no way of knowing if the resolution 
  191. will be switched by a desktop.inf or newdesk.inf file so the
  192. resolution used will be the one used at the time BATCH.PRG runs.
  193.  
  194. Example: (copy two different INF files depending of rez.)
  195.  
  196. #if rez
  197. st medium
  198.  
  199. #rcopy
  200. c:\echidna\fish.med
  201. c:\fish.inf
  202.  
  203. #endif
  204.  
  205. #if rez
  206. st high
  207.  
  208. #rcopy
  209. c:\echidna\fish.hig
  210. c:\fish.inf
  211.  
  212. #endif
  213.  
  214.  
  215. #ON REZ (on resolution)
  216. <Screen resoultion name one>
  217. Stuff to do
  218. #break
  219.  
  220. <Screen resolution name two>
  221. other stuff to do
  222. #break
  223.  
  224. <Screen resoultion name ...>
  225. etc. etc.
  226. #endif
  227.  
  228.     This command, like #IF REZ, is useful for choosing between actions 
  229. depending on resolution; however, it works a bit different. Only the 
  230. commands between the matching resolution and the #BREAK or #ENDIF command 
  231. will be performed, and any number of resolutions may be listed.  The 
  232. resolution  names are the same as with #IF REZ.
  233.  
  234. Example: Chooses between YAK.INF files depending on resolution.
  235.  
  236. #on rez
  237.  
  238. st medium
  239. #rcopy
  240. d:\yak\yakmed.inf
  241. C:\yak.inf
  242. #break  
  243.  
  244. st high
  245. #rcopy
  246. d:\yak\yakhigh.inf
  247. c:\yak.inf
  248. #break
  249.  
  250. ultra high
  251. #rcopy
  252. d:\yak\yakmon.inf
  253. c:\yak.inf
  254.  
  255. #endif
  256.  
  257. Special Commands:
  258.  
  259.     In order to help "debug" your batch files two commands have been 
  260. included to allow you to see what it's doing.  Otherwise only errors will 
  261. be shown on the screen during batch file processing.
  262.  
  263. #ECHO - this will toggle display of the batch file on or off.  When on, 
  264.         the batch file will be echoed to the screen along with the names 
  265.         of all files matching any wildcard commands.
  266.  
  267. #PAUSE - this will stop batch processing until a key is pressed 
  268.          (to let you read the screen)
  269.  
  270.     This is may seem like a simple set of commands (for example, wildcards 
  271. in the destination path are not supported) but it is not intended to be a 
  272. fully functional CLI - it does, however, allow mouse Boot to perform very 
  273. complex tasks upon boot-up and should meet most needs. If interest is high 
  274. enough, I will write a more advanced version.
  275.  
  276. Quick command listing:
  277.  
  278. #copy    - wildcard copy command
  279. #delete  - trash a file or files
  280. #ecopy   - copy and add a new filename extension
  281. #erename - change the extension name on a group of files
  282. #rename  - change the name of a file
  283. #rcopy   - copy and rename
  284. #dcreate - make a folder
  285.  
  286. #if rez  - do commands only if screen rez. matches
  287. #on rez  - do commands between matching rez. and #break
  288. #break   - used between #on rez and #endif to separate resolutions
  289. #endif   - marks end of area affected by #if rez or #on rez commands
  290.  
  291. #echo    - show batch file on screen during processing
  292. #pause   - wait for a keypress
  293.  
  294. #end     - marks end of batch file
  295.  
  296.  
  297.